Package com.cisco.pt.ipc.system
Interface IPCManager
- All Superinterfaces:
IPCObject
- All Known Implementing Classes:
IPCManagerImpl
Information provided by the PKI file:
\class IpcManager
\brief IpcManager serves as the entry point for the IPC and manages ExApps and Script Modules.
\example ipcManager()
- Author:
- Auto-generated
-
Method Summary
Modifier and TypeMethodDescriptionintInformation provided by the PKI file:getOpenData(UUID openId) Information provided by the PKI file:booleanInformation provided by the PKI file:booleanputSaveData(UUID saveId, String saveData) Information provided by the PKI file:booleanregisterOpenFileType(String fileExtension) Information provided by the PKI file:booleansendMessageTo(String cepId, String msg) Information provided by the PKI file:booleansendMessageToAll(String msg) Information provided by the PKI file:booleansendMessageToInstance(UUID cepInstanceId, String msg) Information provided by the PKI file:booleansendMessageToRemote(String cepId, String msg) Information provided by the PKI file:booleansendMessageToRemoteInstance(UUID cepInstanceId, String msg) Information provided by the PKI file:booleansetExclusive(boolean exclusive) Information provided by the PKI file:Information provided by the PKI file:booleanunregisterOpenFileType(String fileExtension) Information provided by the PKI file:Methods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Method Details
-
getListeningPort
int getListeningPort()Information provided by the PKI file:
\brief Returns the listening port for IPC. \return int, the listening port for IPC.- Returns:
- int Returns a int
-
launchCep
Information provided by the PKI file:
\brief Launches the ExApp with the specified ID. \param cepId, the ID of the external process. \return bool, true if successful, otherwise false.- Parameters:
cepId- Takes in a parameter of cepId- Returns:
- boolean Returns a boolean
-
setExclusive
boolean setExclusive(boolean exclusive) Information provided by the PKI file:
\brief Disconnects all other external processes and locks new connections to this external process' ID only. \param exclusive, true to disconnect all external processes of different IDs, false to allow new connections from other external processes. \return bool, true if successful, otherwise false.- Parameters:
exclusive- Takes in a parameter of exclusive- Returns:
- boolean Returns a boolean
-
putSaveData
Information provided by the PKI file:
\brief Saves data with the specified UUID. \param saveId, the UUID of the save data. \param saveData, the data to save. \return bool, true if successful, otherwise false.- Parameters:
saveId- Takes in a parameter of saveIdsaveData- Takes in a parameter of saveData- Returns:
- boolean Returns a boolean
-
getOpenData
Information provided by the PKI file:
\brief Returns the save data with the specified UUID. \param openId, the UUID of the save data. \return QString, the save data with the specified UUID.- Parameters:
openId- Takes in a parameter of openId- Returns:
- String Returns a String
-
thisInstance
CepInstance thisInstance()Information provided by the PKI file:
\brief Returns the CepInstance object for this instance. \return CepInstance, the CepInstance object for this instance.- Returns:
- CepInstance Returns a CepInstance
-
sendMessageTo
Information provided by the PKI file:
\brief Sends a message to the local instance with the specified ID. \paran cepId, the ID of the local instance. \paran msg, the message to send. \return bool, true if successful, otherwise false.- Parameters:
cepId- Takes in a parameter of cepIdmsg- Takes in a parameter of msg- Returns:
- boolean Returns a boolean
-
sendMessageToInstance
Information provided by the PKI file:
\brief Sends a message to the local instance with the specified UUID. \paran cepInstanceId, the UUID of the local instance. \paran msg, the message to send. \return bool, true if successful, otherwise false.- Parameters:
cepInstanceId- Takes in a parameter of cepInstanceIdmsg- Takes in a parameter of msg- Returns:
- boolean Returns a boolean
-
sendMessageToAll
Information provided by the PKI file:
\brief Sends a message to all instances. \paran msg, the message to send. \return bool, true if successful, otherwise false.- Parameters:
msg- Takes in a parameter of msg- Returns:
- boolean Returns a boolean
-
sendMessageToRemote
Information provided by the PKI file:
\brief Sends a message to the remote instance with the specified ID. \param cepId, the ID of the remote instance. \paran msg, the message to send. \return bool, true if successful, otherwise false.- Parameters:
cepId- Takes in a parameter of cepIdmsg- Takes in a parameter of msg- Returns:
- boolean Returns a boolean
-
sendMessageToRemoteInstance
Information provided by the PKI file:
\brief Sends a message to the remote instance with the specified UUID. \param cepInstanceId, the UUID of the remote instance. \paran msg, the message to send. \return bool, true if successful, otherwise false.- Parameters:
cepInstanceId- Takes in a parameter of cepInstanceIdmsg- Takes in a parameter of msg- Returns:
- boolean Returns a boolean
-
registerOpenFileType
Information provided by the PKI file:
\brief Register a file extension to be opened by this CEP instance if the file is opened from PT GUI or OS. \arg fileExtension, the extenstion to register \return bool, true if successful, otherwise false.- Parameters:
fileExtension- Takes in a parameter of fileExtension- Returns:
- boolean Returns a boolean
-
unregisterOpenFileType
Information provided by the PKI file:
\brief Unregister a file extension to be opened by this CEP instance if the file is opened from PT GUI or OS. \arg fileExtension, the extenstion to unregister \return bool, true if successful, otherwise false.- Parameters:
fileExtension- Takes in a parameter of fileExtension- Returns:
- boolean Returns a boolean
-